<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::window class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>window <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__window_8h.html">&lt;bn_window.h&gt;</a></div>
        </h1>
        <p>Base window class.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#derived-classes">Derived classes</a></li>
                <li><a href="#pub-static-methods">Public static functions</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#friends">Friends</a></li>
              </ul>
            </li>
          </ul>
        </nav>
        <section id="derived-classes">
          <h2><a href="#derived-classes">Derived classes</a></h2>
          <dl class="m-doc">
            <dt>
              class <a href="classbn_1_1inside__window.html" class="m-doc">inside_window</a>
            </dt>
            <dd>Window which region can be covered by other window.</dd>
          </dl>
        </section>
        <section id="pub-static-methods">
          <h2><a href="#pub-static-methods">Public static functions</a></h2>
          <dl class="m-doc">
            <dt id="aa31ba449f3fbf3db341eff132200111a">
              <span class="m-doc-wrap-bumper">static auto <a href="#aa31ba449f3fbf3db341eff132200111a" class="m-doc-self">internal</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1window.html" class="m-doc">window</a></span>
            </dt>
            <dd>Returns the closest window to the screen.</dd>
            <dt id="a47668194bffb725865daadd6c5da84ab">
              <span class="m-doc-wrap-bumper">static auto <a href="#a47668194bffb725865daadd6c5da84ab" class="m-doc-self">external</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1window.html" class="m-doc">window</a></span>
            </dt>
            <dd>Returns the closest window to the screen not covered by the internal window.</dd>
            <dt id="aa92be8530cb40a3d23ef11610720dc88">
              <span class="m-doc-wrap-bumper">static auto <a href="#aa92be8530cb40a3d23ef11610720dc88" class="m-doc-self">sprites</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1window.html" class="m-doc">window</a></span>
            </dt>
            <dd>Returns the window made out of the visible pixels of the sprites with the window attribute enabled.</dd>
            <dt id="a8bb92a43df7e31bd6b2b07ccf46b69af">
              <span class="m-doc-wrap-bumper">static auto <a href="#a8bb92a43df7e31bd6b2b07ccf46b69af" class="m-doc-self">outside</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1window.html" class="m-doc">window</a></span>
            </dt>
            <dd>Returns the window of the region not covered by any other window.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt id="a74dfbf66dfdf305bba31b333f60356d4">
              <span class="m-doc-wrap-bumper">auto <a href="#a74dfbf66dfdf305bba31b333f60356d4" class="m-doc-self">id</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns the internal ID.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ab8b1722e1c2e3258ca79640c0d972be1" class="m-doc">show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&amp; regular_bg) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the specified background is shown in this window.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aca77c380eaf931f70ed01b5b4b262d34" class="m-doc">show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1affine__bg__ptr.html" class="m-doc">affine_<wbr />bg_<wbr />ptr</a>&amp; affine_bg) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the specified background is shown in this window.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a3be435e3662c99bc15822af6998eaa2f" class="m-doc">set_show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&amp; regular_bg,
              bool show)</span>
            </dt>
            <dd>Sets if the specified background must be shown in this window.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#abbabc3b0eaf8c8fa126381a5ba73e8d2" class="m-doc">set_show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1affine__bg__ptr.html" class="m-doc">affine_<wbr />bg_<wbr />ptr</a>&amp; affine_bg,
              bool show)</span>
            </dt>
            <dd>Sets if the specified background must be shown in this window.</dd>
            <dt id="aac65fab69df23bbedcff9c6dc1541626">
              <span class="m-doc-wrap-bumper">auto <a href="#aac65fab69df23bbedcff9c6dc1541626" class="m-doc-self">show_sprites</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if sprites are shown in this window.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a8425fd3f5bcd29acd94c56a9ce72228a" class="m-doc">set_show_sprites</a>(</span><span class="m-doc-wrap">bool show)</span>
            </dt>
            <dd>Sets if sprites must be shown in this window.</dd>
            <dt id="aa9b2c2d43bb0811145b068adfd7a3b5f">
              <span class="m-doc-wrap-bumper">auto <a href="#aa9b2c2d43bb0811145b068adfd7a3b5f" class="m-doc-self">show_blending</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if blending is shown in this window.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a73cb422d6797ad4b670ebf71d2dae6df" class="m-doc">set_show_blending</a>(</span><span class="m-doc-wrap">bool show)</span>
            </dt>
            <dd>Sets if blending must be shown in this window.</dd>
            <dt id="a681d95128b9e8dc68b0538d2b5ac1098">
              <span class="m-doc-wrap-bumper">auto <a href="#a681d95128b9e8dc68b0538d2b5ac1098" class="m-doc-self">show_all</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if sprites, backgrounds and blending are shown in this window.</dd>
            <dt id="a9424be720798f44eb73839344b649d52">
              <span class="m-doc-wrap-bumper">void <a href="#a9424be720798f44eb73839344b649d52" class="m-doc-self">set_show_all</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Show sprites, backgrounds and blending in this window.</dd>
            <dt id="a5d186e9c1b3588db08796701f0cb7d15">
              <span class="m-doc-wrap-bumper">auto <a href="#a5d186e9c1b3588db08796701f0cb7d15" class="m-doc-self">show_nothing</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if sprites, backgrounds and blending are hidden in this window.</dd>
            <dt id="a37b1be430271b3bcff55b0879d198e81">
              <span class="m-doc-wrap-bumper">void <a href="#a37b1be430271b3bcff55b0879d198e81" class="m-doc-self">set_show_nothing</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Hide sprites, backgrounds and blending in this window.</dd>
            <dt id="ac655862386ce7a9abeeb5fa69d794c01">
              <span class="m-doc-wrap-bumper">void <a href="#ac655862386ce7a9abeeb5fa69d794c01" class="m-doc-self">restore</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Restores this window to its initial state.</dd>
          </dl>
        </section>
        <section id="friends">
          <h2><a href="#friends">Friends</a></h2>
          <dl class="m-doc">
            <dt id="a8320b61b778051121d6fdba7b3ad04f7">
              <span class="m-doc-wrap-bumper">auto <a href="#a8320b61b778051121d6fdba7b3ad04f7" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1window.html" class="m-doc">window</a>&amp; a,
              const <a href="classbn_1_1window.html" class="m-doc">window</a>&amp; b) -&gt; bool <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>Default equal operator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="ab8b1722e1c2e3258ca79640c0d972be1"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab8b1722e1c2e3258ca79640c0d972be1" class="m-doc-self">show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&amp; regular_bg) const</span></span>
            </h3>
            <p>Indicates if the specified background is shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">regular_bg</td>
                  <td>Regular BG to ask for.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if the specified background is shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="aca77c380eaf931f70ed01b5b4b262d34"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aca77c380eaf931f70ed01b5b4b262d34" class="m-doc-self">show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1affine__bg__ptr.html" class="m-doc">affine_<wbr />bg_<wbr />ptr</a>&amp; affine_bg) const</span></span>
            </h3>
            <p>Indicates if the specified background is shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">affine_bg</td>
                  <td>Affine BG to ask for.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if the specified background is shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a3be435e3662c99bc15822af6998eaa2f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3be435e3662c99bc15822af6998eaa2f" class="m-doc-self">set_show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />ptr</a>&amp; regular_bg,
              bool show)</span></span>
            </h3>
            <p>Sets if the specified background must be shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">regular_bg</td>
                  <td>Regular BG to show or hide.</td>
                </tr>
                <tr>
                  <td>show</td>
                  <td><code>true</code> if the specified background must be shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="abbabc3b0eaf8c8fa126381a5ba73e8d2"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abbabc3b0eaf8c8fa126381a5ba73e8d2" class="m-doc-self">set_show_bg</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1affine__bg__ptr.html" class="m-doc">affine_<wbr />bg_<wbr />ptr</a>&amp; affine_bg,
              bool show)</span></span>
            </h3>
            <p>Sets if the specified background must be shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">affine_bg</td>
                  <td>Affine BG to show or hide.</td>
                </tr>
                <tr>
                  <td>show</td>
                  <td><code>true</code> if the specified background must be shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a8425fd3f5bcd29acd94c56a9ce72228a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8425fd3f5bcd29acd94c56a9ce72228a" class="m-doc-self">set_show_sprites</a>(</span><span class="m-doc-wrap">bool show)</span></span>
            </h3>
            <p>Sets if sprites must be shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">show</td>
                  <td><code>true</code> if sprites must be shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a73cb422d6797ad4b670ebf71d2dae6df"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />window::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a73cb422d6797ad4b670ebf71d2dae6df" class="m-doc-self">set_show_blending</a>(</span><span class="m-doc-wrap">bool show)</span></span>
            </h3>
            <p>Sets if blending must be shown in this window.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">show</td>
                  <td><code>true</code> if blending must be shown in this window, otherwise <code>false</code>.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
